feat: create re-usable github action #60

SgtPooki · 2025-09-30T19:41:06Z

Re-usable github action.. Example usage in filecoin-project/lotus-docs#821

Summary

Adds a reusable composite GitHub Action (filecoin-pin-upload-action) that can run end-to-end or in a two-step prepare/upload flow.
Includes helper modules (inputs.js, cache.js, filecoin.js, outputs.js, errors.js) for clarity, plus comprehensive README guidance on security, permissions, and workflows.

Details

minimal requirement for setup
README updates:
- Setup checklist (pin by commit SHA, restrict allowed actions, grant actions: read, cap maxTopUp, use environments, protect workflows).
- PR safety options (low/zero top-up, label-gated, two-step).
- Two-step & single usage examples.

Fixes #49

SgtPooki · 2025-09-30T21:26:46Z

FYI I keep getting blocked by permission issues.. so i'm moving this to https://github.com/SgtPooki/filecoin-upload-action.

Working now at https://github.com/filecoin-project/lotus-docs/actions/runs/18143867462/job/51641077901?pr=821

comment at filecoin-project/lotus-docs#821 (comment)

BigLep

I think it would be good for me to look with a fresh head, but here some things coming to midn. Thanks for working on this and helping tease out UX things.

.github/actions/filecoin-pin-upload-action/action.yml

.github/actions/upload/action.yml

BigLep · 2025-10-01T04:46:40Z

.github/actions/filecoin-pin-upload-action/action.yml

+  providerAddress:
+    description: Optional override for storage provider address (on Calibration/Mainnet). Defaults to a known good provider on Calibration.
+    required: false
+    default: "0xa3971A7234a3379A1813d9867B531e7EeB20ae07"


How about default to using Synapse's default rather than encoding something here?

This is primarily for testing: ezpzdz was claimed by someone in slack to be "the most reliable" and I've also noticed the same since I started using it... This should be removed from any prod version

Got it. Maybe then to make it clear, we just prefix it with some lime "internal" or "temp"?

.github/actions/filecoin-pin-upload-action/action.yml

.github/actions/filecoin-pin-upload-action/README.md

BigLep · 2025-10-01T05:50:50Z

.github/actions/upload/README.md

Maybe discuss the failure cases that can occur that will fail the action?

this should be covered by FLOW and USAGE now, but we can add into README if we want. there is also src/errors.js that has some common errors we can call out.

.github/actions/upload/action.yml

.github/actions/filecoin-pin-upload-action/README.md

BigLep · 2025-10-01T06:17:35Z

Things I would also want to make sure are in the logs are:

Current deposited balance
Runway of dataset given current amount deposited
Whether any amount was deposited and how much
Size of current artifact that was uploaded

.github/actions/filecoin-pin-upload-action/README.md

.github/actions/filecoin-pin-upload-action/action.yml

.github/actions/upload/action.yml

SgtPooki · 2025-10-01T13:16:46Z

.github/actions/filecoin-pin-upload-action/action.yml

+  providerAddress:
+    description: Optional override for storage provider address (on Calibration/Mainnet). Defaults to a known good provider on Calibration.
+    required: false
+    default: "0xa3971A7234a3379A1813d9867B531e7EeB20ae07"


This is primarily for testing: ezpzdz was claimed by someone in slack to be "the most reliable" and I've also noticed the same since I started using it... This should be removed from any prod version

.github/actions/filecoin-pin-upload-action/action.yml

SgtPooki · 2025-10-01T13:48:34Z

.github/actions/filecoin-pin-upload-action/action.yml

+    default: "0xa3971A7234a3379A1813d9867B531e7EeB20ae07"
+
+outputs:
+  root_cid:


see SgtPooki/filecoin-upload-action@77386ae

SgtPooki · 2025-10-01T13:53:23Z

.github/actions/filecoin-pin-upload-action/action.yml

+            'Filecoin Pin Upload ✅',
+            '',
+            '- IPFS Root CID: `' + IPFS_ROOT_CID + '`',
+            '- Data Set ID: `' + DATA_SET_ID + '`',


yea its at https://pdp.vxb.ai/calibration. I can add it.

SgtPooki · 2025-10-01T14:04:39Z

.github/actions/filecoin-pin-upload-action/action.yml

+          ${{ steps.run.outputs.metadata_path || steps.from-cache.outputs.metadata_path || steps.from-artifact.outputs.metadata_path }}
+
+    - name: Comment on PR with IPFS Root CID
+      if: ${{ github.event_name == 'pull_request' || github.event_name == 'pull_request_target' }}


This command in particular is safe, because it doesn't have access to secrets, but the action does need to be split up into a two workflow process. I am working on that now

.github/actions/filecoin-pin-upload-action/README.md

BigLep · 2025-10-02T18:35:54Z

Things I would also want to make sure are in the logs are:

Current deposited balance

Runway of dataset given current amount deposited

Whether any amount was deposited and how much

Size of current artifact that was uploaded

These would great things to see in the upload job output like https://github.com/SgtPooki/fwss-simple-static-website/actions/runs/18198348463/attempts/2#summary-51810985939

It would also be great if the PR comment linked to this job artifact so someone can see more details

SgtPooki · 2025-10-06T14:04:28Z

FYI this is now working at https://github.com/filecoin-project/filecoin-pin-github-action-test/actions/runs/18283219700/job/52051743238.

will work on renaming now and cleaning up usage so its used with filecoin-project/filecoin-pin/.github/actions/[email protected] or similar. If we want a better name, we could open in a separate repo, so users could target filecoin-project/[email protected] or whatever name we want.

feat: create re-usable github action

f51eec0

SgtPooki linked an issue Sep 30, 2025 that may be closed by this pull request

feat: GitHub Action for Filecoin Pin Uploads #49

Open

3 tasks

chore: fix lint

9505425

SgtPooki requested a review from BigLep September 30, 2025 19:54

fix: use local source

caf1514

BigLep reviewed Oct 1, 2025

View reviewed changes

SgtPooki commented Oct 1, 2025

View reviewed changes

SgtPooki added 2 commits October 3, 2025 16:30

chore: cp code from sgtpooki/filecoin-upload-action

eba600f

docs: add docs and examples

f513fc9

BigLep mentioned this pull request Oct 6, 2025

feat: GitHub Action for Filecoin Pin Uploads #49

Open

3 tasks

SgtPooki added 2 commits October 6, 2025 09:46

fix: lint failures on extension names (#70)

f5feac2

fix: usage by filecoin-project action test

46f8eaf

refactor: rename action

5ff99e9

feat: create re-usable github action #60

Are you sure you want to change the base?

feat: create re-usable github action #60

Conversation

SgtPooki commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details

Uh oh!

SgtPooki commented Sep 30, 2025

Uh oh!

BigLep left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

BigLep commented Oct 1, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

BigLep commented Oct 2, 2025

Uh oh!

SgtPooki commented Oct 6, 2025

Uh oh!

Uh oh!

SgtPooki commented Sep 30, 2025 •

edited

Loading